<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>org.gephi.tools.spi (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="org.gephi.tools.spi (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/tools/api/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/gephi/utils/longtask/api/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/tools/spi/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.gephi.tools.spi</h1>
<div class="docSummary">
<div class="block">Interfaces for creating new tools.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/MouseClickEventListener.html" title="interface in org.gephi.tools.spi">MouseClickEventListener</a></td>
<td class="colLast">
<div class="block">Tool mouse click listener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/NodeClickEventListener.html" title="interface in org.gephi.tools.spi">NodeClickEventListener</a></td>
<td class="colLast">
<div class="block">Tool node click listener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/NodePressAndDraggingEventListener.html" title="interface in org.gephi.tools.spi">NodePressAndDraggingEventListener</a></td>
<td class="colLast">
<div class="block">Tool mouse press and dragging listener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/NodePressingEventListener.html" title="interface in org.gephi.tools.spi">NodePressingEventListener</a></td>
<td class="colLast">
<div class="block">Tool mouse pressing listener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/Tool.html" title="interface in org.gephi.tools.spi">Tool</a></td>
<td class="colLast">
<div class="block">Tools are functions for interacting with user inputs on the visualization window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/ToolEventListener.html" title="interface in org.gephi.tools.spi">ToolEventListener</a></td>
<td class="colLast">
<div class="block">Listeners used by <a href="../../../../org/gephi/tools/spi/Tool.html" title="interface in org.gephi.tools.spi"><code>Tool</code></a> classes for receiving events from the visualization
 window like mouse click, mouse drag, node click etc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/ToolUI.html" title="interface in org.gephi.tools.spi">ToolUI</a></td>
<td class="colLast">
<div class="block">Tool's user interface attributes: name, description, icon and a properties bar.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/ToolSelectionType.html" title="enum in org.gephi.tools.spi">ToolSelectionType</a></td>
<td class="colLast">
<div class="block">Enum setting for <a href="../../../../org/gephi/tools/spi/Tool.html" title="interface in org.gephi.tools.spi"><code>Tool</code></a> implementations.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/gephi/tools/spi/UnselectToolException.html" title="class in org.gephi.tools.spi">UnselectToolException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!--   -->
</a>
<h2 title="Package org.gephi.tools.spi Description">Package org.gephi.tools.spi Description</h2>
<div class="block">Interfaces for creating new tools.
        <p>Tools are functions for interacting with user inputs on the visualization window.</p>
        <h3>How-to create a tool implementation</h3>
        <ol><li>Create a class which implement <code>Tool</code> interface</li>
            <li>Add the following annotation to your class to be declared as a new
                implementation <code>@ServiceProvider(service=Tool.class)</code></li>
            <li>Declare <code>ToolEventListener</code> instances for specifying how the
                tool is interacting with user input like node click or mouse drag.</li>
            <li>Provide a <code>ToolUI</code> instance for giving a name and an icon to your
                tool.</li></ol></div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/tools/api/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/gephi/utils/longtask/api/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/tools/spi/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
